home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / SciAn / technotes / Plot_3D_File_Reader < prev    next >
Text File  |  1994-08-01  |  5KB  |  130 lines
  1. Plot_3D_File_Reader
  2. Tzong-Yow Hwu
  3. December 7, 1992
  4.  
  5. Summary: Description of Plot-3D file reader
  6.  
  7. Beginning with version 0.7 of SciAn, there is a partial implementation of
  8. a reader for Plot-3D format files.  A more complete implementation is 
  9. under development.
  10.  
  11. A set of plot 3d files is composed of a meta file and several data files, which 
  12. must include at least one grid XYZ file and one solution Q file or FUNCTION 
  13. file.  
  14.  
  15. The meta file is an ASCII text file used to specify to the file reader the 
  16. format of the data files. The data files contain data for visulization.  At the
  17. current stage, the file reader is capable of reading files stored in
  18. ASCII text format only.
  19.  
  20. The meta file contains one or more Plot 3D READ commands.  A Plot 3D READ
  21. command is of the syntax:  READ/qualifier1/qualifier2....where the qualifier
  22. may be one or more of the following:
  23.  
  24. /1D
  25. /2D
  26. /3D (default)
  27.    specification of the dimensionality of the data set
  28.  
  29. /XYZ=filename
  30.    specification of the abolute path name of the XYZ file, the filename
  31.    must be enclosed in double quotes
  32.  
  33. /Q=filename
  34.    specification of the abolute path name of the Q file, the filename
  35.    must be enclosed in double quotes
  36.  
  37. /FUNCTION=filename
  38.    specification of the abolute path name of the FUNCTION file, the filename
  39.    must be enclosed in double quotes
  40.  
  41. /MDATASET (defaut is a single dataset)
  42.    specification of multiple datasets in one file (for time-varing datasets)
  43.  
  44. /MGRID (default is a single grid)
  45.    specification of multiple grid datasets in one file
  46.  
  47. /FORMATTED (not implemented yet)
  48. /UNFORMATTED
  49. /BINARY (default) (not implemented yet)
  50.    specification of the file format
  51.  
  52. /PLANES
  53. /WHOLE (default)
  54.    specification of the data arrangement format in the data file
  55.  
  56. /CHECK (default)
  57. /NOCHECK
  58.    specification of whether checking of Q data for zero or negative density
  59.    or pressure is to be performed
  60.  
  61. /JACOBIAN (not implemented)
  62. /NOJACOBIAN (default)
  63.    specification of whether Q varialbes are scaled by the determinant of the
  64.    metric Jacobian
  65.  
  66. /BLANK
  67. /NOBLANK (default)
  68.    specification of whether the XYZ file contains an integer array IBLANK as
  69.    a fourth variable.  The data with a 0 IBLANK value is treated as missing
  70.    in SciAn.
  71.  
  72. The main purpose of qualifiers is to specify the path of data files, data 
  73. format and operations to be done on the data.  To avoid ambiquity, qualifiers 
  74. describing a file must precede the qualifier that specifies the file path name.
  75. At most one of the qualifier in its group may be used for any data file.  
  76. If certain qualifier is not specified for a file, then it inherits the
  77. attributes of the previous file.  If this happens to the first file, then
  78. the default is assumed.
  79.  
  80. It is illegal to specify inconsistent qualifiers for a Q or FUNCTION file and 
  81. its corresponding XYZ file.  For example, if a Q file is described as 3D
  82. then it is an error to have its corresponding XYZ file qualified as 1D or 2D.
  83. It is suggested that all the Q or FUNCTION files using the same XYZ
  84. file as grid be placed in the same READ command and the qualifiers common to 
  85. the data files be placed only once at the beginning of the READ command.
  86.  
  87. A READ command must consist of at least one complete specification of a dataset
  88. for visualization.  A complete specification of a dataset contains at least one 
  89. XYZ file and one Q or FUNCTION file.  A XYZ file may be used for more than
  90. one Q or FUNCTION files in a single READ command, in which case the XYZ file
  91. is used as the grid for the Q and FUNCTION datasets.  A READ command may also
  92. contain specification of more than one XYZ files.  All the Q and FUNCTION
  93. files preceding the second XYZ file are considered using the grid speficied by
  94. the first XYZ file and the XYZ files thereafter are used as grids for the Q
  95. and FUNCTION files before the next specification of XYZ file.  It is illegal
  96. to specify a XYZ file without supplying any Q or FUNCTION file for it.
  97.  
  98. If a READ command is to be separated into two or more lines, a hyphen '-'
  99. must follow the end of the previous line to indicate the continuation of the
  100. command at the next line.
  101.  
  102. The reader is case-insensitive and recongnize abbreviations for each
  103. qualifier.
  104.  
  105. The default extension name of p3d meta file in SciAn is .p3d.
  106.  
  107.  
  108. Example:
  109.  
  110. read/unformatted/mdataset/mgrid/xyz="/user/hwu/xyz.dat"/q="/user/hwu/q.dat"/-
  111. function="/user/hwu/function.dat"
  112.  
  113.  
  114. This read command specifies a Q dataset and a FUNCTION dataset with both of
  115. them using the same XYZ grid.  For attributes not specified, defaults are
  116. assumed, thses include:
  117. /3D
  118. /WHOLE
  119. /CHECK
  120. /NOJACOBIAN
  121. /NOBLANK
  122.  
  123.   ****************************************************************************
  124.   *                              Harry T. Hwu                                *
  125.   *                Supercomputer Computation Research Institute              *
  126.   *                        Florida State University                          *
  127.   *        email:  hwu@scri.fsu.edu      phone:  (904) 644-6263              *
  128.   ****************************************************************************
  129.  
  130.